208 строки
19 KiB
YAML
208 строки
19 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus"
|
|
name: "ServiceBus"
|
|
nameWithType: "ServiceBus"
|
|
summary: "Properties related to Service<wbr>Bus."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties&text=DigitalTwinsEndpointResourceProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.authenticationType()?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.authenticationType&text=authenticationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.createdTime()?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.createdTime&text=createdTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.deadLetterSecret()?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.deadLetterSecret&text=deadLetterSecret\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.deadLetterUri()?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.deadLetterUri&text=deadLetterUri\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.identity()?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.identity&text=identity\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.provisioningState()?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.provisioningState&text=provisioningState\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.validate()?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.validate&text=validate\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withAuthenticationType(com.azure.resourcemanager.digitaltwins.models.AuthenticationType)?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withAuthenticationType&text=withAuthenticationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withDeadLetterSecret(java.lang.String)?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withDeadLetterSecret&text=withDeadLetterSecret\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withDeadLetterUri(java.lang.String)?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withDeadLetterUri&text=withDeadLetterUri\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withIdentity(com.azure.resourcemanager.digitaltwins.models.ManagedIdentityReference)?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withIdentity&text=withIdentity\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ServiceBus**</br> extends <xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties&text=DigitalTwinsEndpointResourceProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.ServiceBus()"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.ServiceBus()"
|
|
name: "ServiceBus()"
|
|
nameWithType: "ServiceBus.ServiceBus()"
|
|
summary: "Creates an instance of Service<wbr>Bus class."
|
|
syntax: "public ServiceBus()"
|
|
desc: "Creates an instance of ServiceBus class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.endpointUri()"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.endpointUri()"
|
|
name: "endpointUri()"
|
|
nameWithType: "ServiceBus.endpointUri()"
|
|
summary: "Get the endpoint<wbr>Uri property: The URL of the Service<wbr>Bus namespace for identity-based authentication."
|
|
syntax: "public String endpointUri()"
|
|
desc: "Get the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'."
|
|
returns:
|
|
description: "the endpointUri value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.entityPath()"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.entityPath()"
|
|
name: "entityPath()"
|
|
nameWithType: "ServiceBus.entityPath()"
|
|
summary: "Get the entity<wbr>Path property: The Service<wbr>Bus Topic name for identity-based authentication."
|
|
syntax: "public String entityPath()"
|
|
desc: "Get the entityPath property: The ServiceBus Topic name for identity-based authentication."
|
|
returns:
|
|
description: "the entityPath value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.primaryConnectionString()"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.primaryConnectionString()"
|
|
name: "primaryConnectionString()"
|
|
nameWithType: "ServiceBus.primaryConnectionString()"
|
|
summary: "Get the primary<wbr>Connection<wbr>String property: Primary<wbr>Connection<wbr>String of the endpoint for key-based authentication."
|
|
syntax: "public String primaryConnectionString()"
|
|
desc: "Get the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read."
|
|
returns:
|
|
description: "the primaryConnectionString value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.secondaryConnectionString()"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.secondaryConnectionString()"
|
|
name: "secondaryConnectionString()"
|
|
nameWithType: "ServiceBus.secondaryConnectionString()"
|
|
summary: "Get the secondary<wbr>Connection<wbr>String property: Secondary<wbr>Connection<wbr>String of the endpoint for key-based authentication."
|
|
syntax: "public String secondaryConnectionString()"
|
|
desc: "Get the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read."
|
|
returns:
|
|
description: "the secondaryConnectionString value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.validate()"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.validate()"
|
|
name: "validate()"
|
|
nameWithType: "ServiceBus.validate()"
|
|
summary: "Validates the instance."
|
|
overridden: "com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.validate()"
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withAuthenticationType(com.azure.resourcemanager.digitaltwins.models.AuthenticationType)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withAuthenticationType(AuthenticationType authenticationType)"
|
|
name: "withAuthenticationType(AuthenticationType authenticationType)"
|
|
nameWithType: "ServiceBus.withAuthenticationType(AuthenticationType authenticationType)"
|
|
summary: "Set the authentication<wbr>Type property: Specifies the authentication type being used for connecting to the endpoint."
|
|
overridden: "com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withAuthenticationType(com.azure.resourcemanager.digitaltwins.models.AuthenticationType)"
|
|
parameters:
|
|
- name: "authenticationType"
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.AuthenticationType?alt=com.azure.resourcemanager.digitaltwins.models.AuthenticationType&text=AuthenticationType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ServiceBus withAuthenticationType(AuthenticationType authenticationType)"
|
|
desc: "Set the authenticationType property: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified."
|
|
returns:
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withDeadLetterSecret(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withDeadLetterSecret(String deadLetterSecret)"
|
|
name: "withDeadLetterSecret(String deadLetterSecret)"
|
|
nameWithType: "ServiceBus.withDeadLetterSecret(String deadLetterSecret)"
|
|
summary: "Set the dead<wbr>Letter<wbr>Secret property: Dead letter storage secret for key-based authentication."
|
|
overridden: "com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withDeadLetterSecret(java.lang.String)"
|
|
parameters:
|
|
- name: "deadLetterSecret"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ServiceBus withDeadLetterSecret(String deadLetterSecret)"
|
|
desc: "Set the deadLetterSecret property: Dead letter storage secret for key-based authentication. Will be obfuscated during read."
|
|
returns:
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withDeadLetterUri(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withDeadLetterUri(String deadLetterUri)"
|
|
name: "withDeadLetterUri(String deadLetterUri)"
|
|
nameWithType: "ServiceBus.withDeadLetterUri(String deadLetterUri)"
|
|
summary: "Set the dead<wbr>Letter<wbr>Uri property: Dead letter storage URL for identity-based authentication."
|
|
overridden: "com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withDeadLetterUri(java.lang.String)"
|
|
parameters:
|
|
- name: "deadLetterUri"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ServiceBus withDeadLetterUri(String deadLetterUri)"
|
|
desc: "Set the deadLetterUri property: Dead letter storage URL for identity-based authentication."
|
|
returns:
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withEndpointUri(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withEndpointUri(String endpointUri)"
|
|
name: "withEndpointUri(String endpointUri)"
|
|
nameWithType: "ServiceBus.withEndpointUri(String endpointUri)"
|
|
summary: "Set the endpoint<wbr>Uri property: The URL of the Service<wbr>Bus namespace for identity-based authentication."
|
|
parameters:
|
|
- description: "the endpointUri value to set."
|
|
name: "endpointUri"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ServiceBus withEndpointUri(String endpointUri)"
|
|
desc: "Set the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'."
|
|
returns:
|
|
description: "the ServiceBus object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withEntityPath(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withEntityPath(String entityPath)"
|
|
name: "withEntityPath(String entityPath)"
|
|
nameWithType: "ServiceBus.withEntityPath(String entityPath)"
|
|
summary: "Set the entity<wbr>Path property: The Service<wbr>Bus Topic name for identity-based authentication."
|
|
parameters:
|
|
- description: "the entityPath value to set."
|
|
name: "entityPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ServiceBus withEntityPath(String entityPath)"
|
|
desc: "Set the entityPath property: The ServiceBus Topic name for identity-based authentication."
|
|
returns:
|
|
description: "the ServiceBus object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withIdentity(com.azure.resourcemanager.digitaltwins.models.ManagedIdentityReference)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withIdentity(ManagedIdentityReference identity)"
|
|
name: "withIdentity(ManagedIdentityReference identity)"
|
|
nameWithType: "ServiceBus.withIdentity(ManagedIdentityReference identity)"
|
|
summary: "Set the identity property: Managed identity properties for the endpoint."
|
|
overridden: "com.azure.resourcemanager.digitaltwins.models.DigitalTwinsEndpointResourceProperties.withIdentity(com.azure.resourcemanager.digitaltwins.models.ManagedIdentityReference)"
|
|
parameters:
|
|
- name: "identity"
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ManagedIdentityReference?alt=com.azure.resourcemanager.digitaltwins.models.ManagedIdentityReference&text=ManagedIdentityReference\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ServiceBus withIdentity(ManagedIdentityReference identity)"
|
|
desc: "Set the identity property: Managed identity properties for the endpoint."
|
|
returns:
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withPrimaryConnectionString(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withPrimaryConnectionString(String primaryConnectionString)"
|
|
name: "withPrimaryConnectionString(String primaryConnectionString)"
|
|
nameWithType: "ServiceBus.withPrimaryConnectionString(String primaryConnectionString)"
|
|
summary: "Set the primary<wbr>Connection<wbr>String property: Primary<wbr>Connection<wbr>String of the endpoint for key-based authentication."
|
|
parameters:
|
|
- description: "the primaryConnectionString value to set."
|
|
name: "primaryConnectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ServiceBus withPrimaryConnectionString(String primaryConnectionString)"
|
|
desc: "Set the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read."
|
|
returns:
|
|
description: "the ServiceBus object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withSecondaryConnectionString(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.digitaltwins.models.ServiceBus.withSecondaryConnectionString(String secondaryConnectionString)"
|
|
name: "withSecondaryConnectionString(String secondaryConnectionString)"
|
|
nameWithType: "ServiceBus.withSecondaryConnectionString(String secondaryConnectionString)"
|
|
summary: "Set the secondary<wbr>Connection<wbr>String property: Secondary<wbr>Connection<wbr>String of the endpoint for key-based authentication."
|
|
parameters:
|
|
- description: "the secondaryConnectionString value to set."
|
|
name: "secondaryConnectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ServiceBus withSecondaryConnectionString(String secondaryConnectionString)"
|
|
desc: "Set the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read."
|
|
returns:
|
|
description: "the ServiceBus object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.ServiceBus?alt=com.azure.resourcemanager.digitaltwins.models.ServiceBus&text=ServiceBus\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Properties related to ServiceBus."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.digitaltwins.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-digitaltwins:1.2.0
|