azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.managem...

132 строки
12 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.management.batch.CertificateReference"
fullName: "com.microsoft.azure.management.batch.CertificateReference"
name: "CertificateReference"
nameWithType: "CertificateReference"
summary: "A reference to a certificate to be installed on compute nodes in a pool."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **CertificateReference**"
constructors:
- uid: "com.microsoft.azure.management.batch.CertificateReference.CertificateReference()"
fullName: "com.microsoft.azure.management.batch.CertificateReference.CertificateReference()"
name: "CertificateReference()"
nameWithType: "CertificateReference.CertificateReference()"
syntax: "public CertificateReference()"
methods:
- uid: "com.microsoft.azure.management.batch.CertificateReference.id()"
fullName: "com.microsoft.azure.management.batch.CertificateReference.id()"
name: "id()"
nameWithType: "CertificateReference.id()"
summary: "Get the id value."
syntax: "public String id()"
desc: "Get the id value."
returns:
description: "the id value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.batch.CertificateReference.storeLocation()"
fullName: "com.microsoft.azure.management.batch.CertificateReference.storeLocation()"
name: "storeLocation()"
nameWithType: "CertificateReference.storeLocation()"
summary: "Get the default value is current<wbr>User."
syntax: "public CertificateStoreLocation storeLocation()"
desc: "Get the default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ\\_BATCH\\_CERTIFICATES\\_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/\\{user-name\\}/certs) and certificates are placed in that directory. Possible values include: 'CurrentUser', 'LocalMachine'."
returns:
description: "the storeLocation value"
type: "<xref href=\"com.microsoft.azure.management.batch.CertificateStoreLocation?alt=com.microsoft.azure.management.batch.CertificateStoreLocation&text=CertificateStoreLocation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.batch.CertificateReference.storeName()"
fullName: "com.microsoft.azure.management.batch.CertificateReference.storeName()"
name: "storeName()"
nameWithType: "CertificateReference.storeName()"
summary: "Get this property is applicable only for pools configured with Windows nodes (that is, created with cloud<wbr>Service<wbr>Configuration, or with virtual<wbr>Machine<wbr>Configuration using a Windows image reference)."
syntax: "public String storeName()"
desc: "Get this property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My."
returns:
description: "the storeName value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.batch.CertificateReference.visibility()"
fullName: "com.microsoft.azure.management.batch.CertificateReference.visibility()"
name: "visibility()"
nameWithType: "CertificateReference.visibility()"
summary: "Get the visibility value."
syntax: "public List<CertificateVisibility> visibility()"
desc: "Get the visibility value."
returns:
description: "the visibility value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.batch.CertificateVisibility?alt=com.microsoft.azure.management.batch.CertificateVisibility&text=CertificateVisibility\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.batch.CertificateReference.withId(java.lang.String)"
fullName: "com.microsoft.azure.management.batch.CertificateReference.withId(String id)"
name: "withId(String id)"
nameWithType: "CertificateReference.withId(String id)"
summary: "Set the id value."
parameters:
- description: "the id value to set"
name: "id"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CertificateReference withId(String id)"
desc: "Set the id value."
returns:
description: "the CertificateReference object itself."
type: "<xref href=\"com.microsoft.azure.management.batch.CertificateReference?alt=com.microsoft.azure.management.batch.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.batch.CertificateReference.withStoreLocation(com.microsoft.azure.management.batch.CertificateStoreLocation)"
fullName: "com.microsoft.azure.management.batch.CertificateReference.withStoreLocation(CertificateStoreLocation storeLocation)"
name: "withStoreLocation(CertificateStoreLocation storeLocation)"
nameWithType: "CertificateReference.withStoreLocation(CertificateStoreLocation storeLocation)"
summary: "Set the default value is current<wbr>User."
parameters:
- description: "the storeLocation value to set"
name: "storeLocation"
type: "<xref href=\"com.microsoft.azure.management.batch.CertificateStoreLocation?alt=com.microsoft.azure.management.batch.CertificateStoreLocation&text=CertificateStoreLocation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CertificateReference withStoreLocation(CertificateStoreLocation storeLocation)"
desc: "Set the default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ\\_BATCH\\_CERTIFICATES\\_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/\\{user-name\\}/certs) and certificates are placed in that directory. Possible values include: 'CurrentUser', 'LocalMachine'."
returns:
description: "the CertificateReference object itself."
type: "<xref href=\"com.microsoft.azure.management.batch.CertificateReference?alt=com.microsoft.azure.management.batch.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.batch.CertificateReference.withStoreName(java.lang.String)"
fullName: "com.microsoft.azure.management.batch.CertificateReference.withStoreName(String storeName)"
name: "withStoreName(String storeName)"
nameWithType: "CertificateReference.withStoreName(String storeName)"
summary: "Set this property is applicable only for pools configured with Windows nodes (that is, created with cloud<wbr>Service<wbr>Configuration, or with virtual<wbr>Machine<wbr>Configuration using a Windows image reference)."
parameters:
- description: "the storeName value to set"
name: "storeName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CertificateReference withStoreName(String storeName)"
desc: "Set this property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My."
returns:
description: "the CertificateReference object itself."
type: "<xref href=\"com.microsoft.azure.management.batch.CertificateReference?alt=com.microsoft.azure.management.batch.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.batch.CertificateReference.withVisibility(java.util.List<com.microsoft.azure.management.batch.CertificateVisibility>)"
fullName: "com.microsoft.azure.management.batch.CertificateReference.withVisibility(List<CertificateVisibility> visibility)"
name: "withVisibility(List<CertificateVisibility> visibility)"
nameWithType: "CertificateReference.withVisibility(List<CertificateVisibility> visibility)"
summary: "Set the visibility value."
parameters:
- description: "the visibility value to set"
name: "visibility"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.batch.CertificateVisibility?alt=com.microsoft.azure.management.batch.CertificateVisibility&text=CertificateVisibility\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public CertificateReference withVisibility(List<CertificateVisibility> visibility)"
desc: "Set the visibility value."
returns:
description: "the CertificateReference object itself."
type: "<xref href=\"com.microsoft.azure.management.batch.CertificateReference?alt=com.microsoft.azure.management.batch.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool."
metadata: {}
package: "com.microsoft.azure.management.batch"
artifact: com.microsoft.azure:azure-mgmt-batch:1.41.4